.. Copyright 2019 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode VES Class Definition - part 1 ----------------------------- .. contents:: :depth: 3 .. CmNotify ~~~~~~~~ **Parent class:** VesEvent Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Experimental ======================= =============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** additionalInformation HashMap 0..1 OpenModelAttribute Additional information nf provider wants to convey. Ves::Diagrams::CmNotify::additionalInformation - isInvariant: false - valueRange: no range constraint - support: MANDATORY cmNotifyFieldsVersion String 1 OpenModelAttribute Version of the cmNotify Ves::Diagrams::CmNotify::cmNotifyFieldsVersion - isInvariant: false - valueRange: no range constraint - support: MANDATORY correlatedNotifications invalid 0..\* OpenModelAttribute Notifications to which this notification is considered to be correlated Ves::Diagrams::CmNotify::correlatedNotifications - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventTime DateTime 1 OpenModelAttribute Time of the cmNotify event. Ves::Diagrams::CmNotify::eventTime - isInvariant: false - valueRange: no range constraint - support: MANDATORY notificationId String 1 OpenModelAttribute Unique Identifier for the source of this occurrence of the notification. For 3GPP devices this is the notification identifier as defined by ITUT Ves::Diagrams::CmNotify::notificationId - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceIndicator SourceIndicator 0..1 OpenModelAttribute Indicates the source of the operation that led to the generation of the notification. Ves::Diagrams::CmNotify::sourceIndicator - isInvariant: false - valueRange: no range constraint - support: MANDATORY systemDN String 0..1 OpenModelAttribute DN of the management service provider Ves::Diagrams::CmNotify::systemDN - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_cmnotif cmNotif 1..\* OpenModelAttribute Array of cmNotif notificatons Ves::Diagrams::CmNotify::_cmnotif - isInvariant: false - valueRange: no range constraint - support: MANDATORY domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). OpenModelAttribute the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY name String 1 Preliminary Ves::ObjectClasses::VesEvent::name OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. - isInvariant: false - valueRange: no range constraint - support: MANDATORY ======================= =============== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== CodecsInUse ~~~~~~~~~~~ The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ============================= ================================================ **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** codecIdentifier String 1 Preliminary Description of the codec. Ves::ObjectClasses::CodecsInUse::codecIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numberInUse Integer 1 Preliminary Number of such codecs in use. Ves::ObjectClasses::CodecsInUse::numberInUse OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ============================= ================================================ CpuUsage ~~~~~~~~ The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ===================== ======== ========= ================================== ================================================================================================================================= =================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** cpuCapacityContention Number 0..1 Preliminary The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuCapacityContention OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuDemandAvg Number 0..1 Preliminary The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuDemandAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuDemandMhz Number 0..1 Preliminary CPU demand in MHz Ves::ObjectClasses::CpuUsage::cpuDemandMhz OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuDemandPct Number 0..1 Preliminary CPU demand as a percentage of the provisioned capacity Ves::ObjectClasses::CpuUsage::cpuDemandPct OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuIdentifier String 1 Preliminary CPU Identifier Ves::ObjectClasses::CpuUsage::cpuIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuIdle Number 0..1 Preliminary Percentage of CPU time spent in the idle task Ves::ObjectClasses::CpuUsage::cpuIdle OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuLatencyAvg Number 0..1 Preliminary cpuDemandAvg - The total CPU time that the VNF/VNFC/VM could use if there is no contention, in milliseconds. Ves::ObjectClasses::CpuUsage::cpuLatencyAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuOverheadAvg Number 0..1 Preliminary The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuOverheadAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuSwapWaitTime Number 0..1 Preliminary Swap wait time, in milliseconds over the measurementInterval Ves::ObjectClasses::CpuUsage::cpuSwapWaitTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageInterrupt Number 0..1 Preliminary Percentage of time spent servicing interrupts Ves::ObjectClasses::CpuUsage::cpuUsageInterrupt OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageNice Number 0..1 Preliminary Percentage of time spent running user space processes that have been niced Ves::ObjectClasses::CpuUsage::cpuUsageNice OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageSoftIrq Number 0..1 Preliminary Percentage of time spent handling soft irq interrupts Ves::ObjectClasses::CpuUsage::cpuUsageSoftIrq OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageSteal Number 0..1 Preliminary Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing Ves::ObjectClasses::CpuUsage::cpuUsageSteal OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageSystem Number 0..1 Preliminary Percentage of time spent on system tasks running the kernel Ves::ObjectClasses::CpuUsage::cpuUsageSystem OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuUsageUser Number 0..1 Preliminary Percentage of time spent running un-niced user space processes Ves::ObjectClasses::CpuUsage::cpuUsageUser OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cpuWait Number 0..1 Preliminary Percentage of CPU time spent waiting for I/O operations to complete Ves::ObjectClasses::CpuUsage::cpuWait OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY percentUsage Number 1 Preliminary Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running Ves::ObjectClasses::CpuUsage::percentUsage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ===================== ======== ========= ================================== ================================================================================================================================= =================================================== DiskUsage ~~~~~~~~~ The diskUsage datatype defines the usage of a disk device. Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ========================= ======== ========= ================================== ============================================================================================================================================================================================================================ ======================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** diskBusResets Number 0..1 Preliminary The number of bus resets in the performance interval. Ves::ObjectClasses::DiskUsage::diskBusResets OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskCommandsAborted Number 0..1 Preliminary Number of disk commands aborted over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskCommandsAborted OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskCommandsAvg Number 0..1 Preliminary Average number of commands per second over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskCommandsAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskFlushRequests Number 0..1 Preliminary Total flush requests of the disk cache over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskFlushRequests OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskFlushTime Number 0..1 Preliminary Milliseconds spent on disk cache flushing over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskFlushTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskIdentifier String 1 Preliminary Disk Identifier. Ves::ObjectClasses::DiskUsage::diskIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskIoTimeAvg Number 1 Preliminary Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval Ves::ObjectClasses::DiskUsage::diskIoTimeAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskIoTimeLast Number 0..1 Preliminary Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskIoTimeLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskIoTimeMax Number 0..1 Preliminary Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval Ves::ObjectClasses::DiskUsage::diskIoTimeMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskIoTimeMin Number 0..1 Preliminary Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskIoTimeMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedReadAvg Number 0..1 Preliminary Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedReadAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedReadLast Number 0..1 Preliminary Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedReadLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedReadMax Number 0..1 Preliminary Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedReadMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedReadMin Number 0..1 Preliminary Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedReadMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedWriteAvg Number 0..1 Preliminary Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval Ves::ObjectClasses::DiskUsage::diskMergedWriteAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedWriteLast Number 0..1 Preliminary Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedWriteLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedWriteMax Number 0..1 Preliminary Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedWriteMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskMergedWriteMin Number 0..1 Preliminary Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskMergedWriteMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsReadAvg Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsReadLast Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval Ves::ObjectClasses::DiskUsage::diskOctetsReadLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsReadMax Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsReadMin Number 0..1 Preliminary Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsReadMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsWriteAvg Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsWriteLast Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsWriteMax Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOctetsWriteMin Number 0..1 Preliminary Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOctetsWriteMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsReadAvg Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsReadLast Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsReadMax Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsReadMin Number 0..1 Preliminary Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsReadMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsWriteAvg Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsWriteLast Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsWriteMax Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskOpsWriteMin Number 0..1 Preliminary Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskOpsWriteMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskPendingOperationsAvg Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskPendingOperationsLast Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskPendingOperationsMax Number 0..1 Preliminary Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskPendingOperationsMin Number 0..1 Preliminary diskPendingOperationsMin - Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskPendingOperationsMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskReadCommandsAvg Number 0..1 Preliminary Average number of read commands issued per second to the disk over the measurementInterval. Ves::ObjectClasses::DiskUsage::diskReadCommandsAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTime Number 0..1 Preliminary Nanoseconds spent on disk cache reads/writes within the measurementInterval. Ves::ObjectClasses::DiskUsage::diskTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeReadAvg Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeReadLast Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeReadMax Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeReadMin Number 0..1 Preliminary Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeReadMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeWriteAvg Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the average measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeWriteLast Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the last measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeWriteMax Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTimeWriteMin Number 0..1 Preliminary Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval. Ves::ObjectClasses::DiskUsage::diskTimeWriteMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTotalReadLatencyAvg Number 0..1 Preliminary The average amount of time taken for a read from the perspective of a Guest OS. This is the sum of Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval. Ves::ObjectClasses::DiskUsage::diskTotalReadLatencyAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskTotalWriteLatencyAvg Number 0..1 Preliminary The average amount of time taken for a write from the perspective of a Guest OS. This is the sum of Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval. Ves::ObjectClasses::DiskUsage::diskTotalWriteLatencyAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskWeightedIoTimeAvg Number 0..1 Preliminary Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskWeightedIoTimeLast Number 0..1 Preliminary Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeLast OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskWeightedIoTimeMax Number 0..1 Preliminary Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMax OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskWeightedIoTimeMin Number 0..1 Preliminary Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. Ves::ObjectClasses::DiskUsage::diskWeightedIoTimeMin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY diskWriteCommandsAvg Number 0..1 Preliminary Average number of write commands issued per second to the disk over the measurementInterval Ves::ObjectClasses::DiskUsage::diskWriteCommandsAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ========================= ======== ========= ================================== ============================================================================================================================================================================================================================ ======================================================== EndOfCallVqmSummaries ~~~~~~~~~~~~~~~~~~~~~ Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ============================= =================== ========= ================================== ============================================================================================================================================================================================================== ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** adjacencyName String 1 Preliminary Adjacency name Ves::ObjectClasses::EndOfCallVqmSummaries::adjacencyName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointAverageJitter Number 0..1 Preliminary Endpoint average jitter Ves::ObjectClasses::EndOfCallVqmSummaries::endpointAverageJitter OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointDescription EndpointDescription 1 Preliminary Enumeration: 'Caller', 'Callee' Ves::ObjectClasses::EndOfCallVqmSummaries::endpointDescription OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointMaxJitter Number 0..1 Preliminary Endpoint maximum jitter Ves::ObjectClasses::EndOfCallVqmSummaries::endpointMaxJitter OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpOctetsDiscarded Number 0..1 Preliminary Endpoint RTP octets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsDiscarded OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpOctetsLost Number 0..1 Preliminary Endpoint RTP octets lost Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsLost OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpOctetsReceived Number 0..1 Preliminary Endpoint RTP octets received Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpOctetsSent Number 0..1 Preliminary Endpoint RTP octets sent Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpOctetsSent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpPacketsDiscarded Number 0..1 Preliminary Endpoint RTP packets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsDiscarded OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpPacketsLost Number 0..1 Preliminary Endpoint RTP packets lost Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsLost OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpPacketsReceived Number 0..1 Preliminary Endpoint RTP packets received Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY endpointRtpPacketsSent Number 0..1 Preliminary Endpoint RTP packets sent Ves::ObjectClasses::EndOfCallVqmSummaries::endpointRtpPacketsSent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localAverageJitter Number 0..1 Preliminary Local average jitter Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitter OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localAverageJitterBufferDelay Number 0..1 Preliminary Local average jitter buffer delay Ves::ObjectClasses::EndOfCallVqmSummaries::localAverageJitterBufferDelay OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localMaxJitter Number 0..1 Preliminary Local maximum jitter Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitter OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localMaxJitterBufferDelay Number 0..1 Preliminary Local max jitter buffer delay Ves::ObjectClasses::EndOfCallVqmSummaries::localMaxJitterBufferDelay OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpOctetsDiscarded Number 0..1 Preliminary Local RTP octets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsDiscarded OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpOctetsLost Number 0..1 Preliminary Local RTP octets lost Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsLost OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpOctetsReceived Number 0..1 Preliminary Local RTP octets received Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpOctetsSent Number 0..1 Preliminary Local RTP octets sent Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpOctetsSent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpPacketsDiscarded Number 0..1 Preliminary Local RTP packets discarded Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsDiscarded OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpPacketsLost Number 0..1 Preliminary Local RTP packets lost Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsLost OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpPacketsReceived Number 0..1 Preliminary Local RTP packets received Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY localRtpPacketsSent Number 0..1 Preliminary Local RTP packets sent Ves::ObjectClasses::EndOfCallVqmSummaries::localRtpPacketsSent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mosCqe Number 0..1 Preliminary Decimal range from 1 to 5 (1 decimal place) Ves::ObjectClasses::EndOfCallVqmSummaries::mosCqe OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY oneWayDelay Number 0..1 Preliminary one-way path delay in milliseconds Ves::ObjectClasses::EndOfCallVqmSummaries::oneWayDelay OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY packetLossPercent Number 0..1 Preliminary Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) Ves::ObjectClasses::EndOfCallVqmSummaries::packetLossPercent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY rFactor Number 0..1 Preliminary rFactor from 0 to 100 Ves::ObjectClasses::EndOfCallVqmSummaries::rFactor OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY roundTripDelay Number 0..1 Preliminary Round trip delay in milliseconds Ves::ObjectClasses::EndOfCallVqmSummaries::roundTripDelay OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ============================= =================== ========= ================================== ============================================================================================================================================================================================================== ======================================================================== Fault ~~~~~ Fields specific to fault events **Parent class:** VesEvent Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ========================== ============= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** alarmAdditionalInformation HashMap 0..1 Preliminary Additional alarm information. Ves::ObjectClasses::Fault::alarmAdditionalInformation ? Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). OpenModelAttribute ? Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as 'alarmId':'alarmIdValue'. Could contain managed object instance as separate key:value; could add probable cause as separate key:value. - isInvariant: false - valueRange: no range constraint - support: MANDATORY alarmCondition String 1 Preliminary Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) Ves::ObjectClasses::Fault::alarmCondition OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY alarmInterfaceA String 0..1 Preliminary Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. Ves::ObjectClasses::Fault::alarmInterfaceA OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventCatagory String 0..1 Preliminary Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' Ves::ObjectClasses::Fault::eventCatagory OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventSeverity EventSeverity 1 Preliminary Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'. NORMAL is used to represent clear. Ves::ObjectClasses::Fault::eventSeverity OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventSourceType String 1 Preliminary Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'. This could be managed object class. Ves::ObjectClasses::Fault::eventSourceType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY faultFieldsVersion String 1 Preliminary Version of the faultFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Fault::faultFieldsVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY specificProblem String 1 Preliminary Description of the alarm or problem (e.g., 'eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost'). 3GPP probable cause would be included in this field. Ves::ObjectClasses::Fault::specificProblem OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vfStatus VfStatus 1 Preliminary Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' Ves::ObjectClasses::Fault::vfStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). OpenModelAttribute the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY name String 1 Preliminary Ves::ObjectClasses::VesEvent::name OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. - isInvariant: false - valueRange: no range constraint - support: MANDATORY ========================== ============= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== FilesystemUsage ~~~~~~~~~~~~~~~ The filesystemUsage datatype consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =================== ======== ========= ================================== ===================================================== ======================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** blockConfigured Number 1 Preliminary Configured block storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::blockConfigured OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY blockops Number 1 Preliminary Block storage input-output operations per second. Ves::ObjectClasses::FilesystemUsage::blockops OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY blockUsed Number 1 Preliminary Used block storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::blockUsed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ephemeralConfigured Number 1 Preliminary Configured ephemeral storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::ephemeralConfigured OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ephemerallops Number 1 Preliminary Ephemeral storage input-output operations per second. Ves::ObjectClasses::FilesystemUsage::ephemerallops OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ephemeralUsed Number 1 Preliminary Used ephemeral storage capacity in GB. Ves::ObjectClasses::FilesystemUsage::ephemeralUsed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY filesysytemName String 1 Preliminary File system name. Ves::ObjectClasses::FilesystemUsage::filesysytemName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =================== ======== ========= ================================== ===================================================== ======================================================== GtpPerFlowMetrics ~~~~~~~~~~~~~~~~~ Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================================ ======== ========= ================================== =============================================================================================================================================================================================================== ======================================================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** avgBitErrorRate Number 1 Preliminary Average bit error rate Ves::ObjectClasses::GtpPerFlowMetrics::avgBitErrorRate OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY avgPacketDelayVariation Number 1 Preliminary Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketDelayVariation OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY avgPacketLatency Number 1 Preliminary Average delivery latency Ves::ObjectClasses::GtpPerFlowMetrics::avgPacketLatency OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY avgReceiveThroughput Number 1 Preliminary Average receive throughput Ves::ObjectClasses::GtpPerFlowMetrics::avgReceiveThroughput OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY avgTransmitThroughput Number 1 Preliminary Average transmit throughput Ves::ObjectClasses::GtpPerFlowMetrics::avgTransmitThroughput OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY durConnectionFailedStatus Number 0..1 Preliminary Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval Ves::ObjectClasses::GtpPerFlowMetrics::durConnectionFailedStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY durTunnelFailedStatus Number 0..1 Preliminary Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval Ves::ObjectClasses::GtpPerFlowMetrics::durTunnelFailedStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowActivatedBy String 0..1 Preliminary Endpoint activating the flow Ves::ObjectClasses::GtpPerFlowMetrics::flowActivatedBy OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowActivationEpoch Number 1 Preliminary Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationEpoch OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowActivationMicrosec Number 1 Preliminary Integer microseconds for the start of the flow connection Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowActivationTime String 0..1 Preliminary Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' Ves::ObjectClasses::GtpPerFlowMetrics::flowActivationTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowDeactivatedBy String 0..1 Preliminary Endpoint deactivating the flow Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivatedBy OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowDeactivationEpoch Number 1 Preliminary Time for the start of the flow connection, in integer UTC epoch time aka UNIX time Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationEpoch OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowDeactivationMicrosec Number 1 Preliminary Integer microseconds for the start of the flow connection Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowDeactivationTime String 1 Preliminary Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' Ves::ObjectClasses::GtpPerFlowMetrics::flowDeactivationTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowStatus String 1 Preliminary Connection status at reporting time as a working / inactive / failed indicator value Ves::ObjectClasses::GtpPerFlowMetrics::flowStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY gtpConnectionStatus String 0..1 Preliminary Current connection state at reporting time Ves::ObjectClasses::GtpPerFlowMetrics::gtpConnectionStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY gtpTunnelStatus String 0..1 Preliminary Current tunnel state at reporting time Ves::ObjectClasses::GtpPerFlowMetrics::gtpTunnelStatus OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ipTosCountList HashMap 0..1 Preliminary Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow Ves::ObjectClasses::GtpPerFlowMetrics::ipTosCountList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ipTosList String 0..1 Preliminary Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' Ves::ObjectClasses::GtpPerFlowMetrics::ipTosList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY largePacketRtt Number 0..1 Preliminary large packet round trip time Ves::ObjectClasses::GtpPerFlowMetrics::largePacketRtt OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY largePacketThreshold Number 0..1 Preliminary large packet threshold being applied Ves::ObjectClasses::GtpPerFlowMetrics::largePacketThreshold OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY maxPacketDelayVariation Number 0..1 Preliminary Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets Ves::ObjectClasses::GtpPerFlowMetrics::maxPacketDelayVariation OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY maxReceiveBitRate Number 0..1 Preliminary maximum receive bit rate" Ves::ObjectClasses::GtpPerFlowMetrics::maxReceiveBitRate OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY maxTransmitBitRate Number 0..1 Preliminary maximum transmit bit rate Ves::ObjectClasses::GtpPerFlowMetrics::maxTransmitBitRate OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mobileQciCosCountList HashMap 0..1 Preliminary array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosCountList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mobileQciCosList String 0..1 Preliminary Array of unique LTE QCI or UMTS class-of-service values observed in the flow Ves::ObjectClasses::GtpPerFlowMetrics::mobileQciCosList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numActivationFailures Number 1 Preliminary Number of failed activation requests, as observed by the reporting node Ves::ObjectClasses::GtpPerFlowMetrics::numActivationFailures OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numBitErrors Number 1 Preliminary number of errored bits Ves::ObjectClasses::GtpPerFlowMetrics::numBitErrors OpenModelAttribute number of errored bits - isInvariant: false - valueRange: no range constraint - support: MANDATORY numBytesReceived Number 1 Preliminary number of bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numBytesReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numBytesTransmitted Number 1 Preliminary number of bytes transmitted, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numBytesTransmitted OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numDroppedPackets Number 1 Preliminary number of received packets dropped due to errors per virtual interface Ves::ObjectClasses::GtpPerFlowMetrics::numDroppedPackets OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numGtpEchoFailures Number 0..1 Preliminary Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 Ves::ObjectClasses::GtpPerFlowMetrics::numGtpEchoFailures OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numGtpTunnelErrors Number 0..1 Preliminary Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 Ves::ObjectClasses::GtpPerFlowMetrics::numGtpTunnelErrors OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numHttpErrors Number 0..1 Preliminary Http error count Ves::ObjectClasses::GtpPerFlowMetrics::numHttpErrors OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numL7BytesReceived Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numL7BytesTransmitted Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numL7BytesTransmitted OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numLostPackets Number 1 Preliminary number of tunneled layer 7 bytes received, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numLostPackets OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numOutOfOrderPackets Number 1 Preliminary number of out-of-order packets Ves::ObjectClasses::GtpPerFlowMetrics::numOutOfOrderPackets OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numPacketErrors Number 1 Preliminary number of errored packets Ves::ObjectClasses::GtpPerFlowMetrics::numPacketErrors OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numPacketsReceivedExclRetrans Number 1 Preliminary number of packets received, excluding retransmission Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedExclRetrans OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numPacketsReceivedInclRetrans Number 1 Preliminary number of packets received, including retransmission Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsReceivedInclRetrans OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numPacketsTransmittedInclRetrans Number 1 Preliminary number of packets transmitted, including retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numPacketsTransmittedInclRetrans OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numRetries Number 1 Preliminary number of packet retrie Ves::ObjectClasses::GtpPerFlowMetrics::numRetries OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numTimeouts Number 1 Preliminary number of packet timeouts Ves::ObjectClasses::GtpPerFlowMetrics::numTimeouts OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numTunneledL7BytesReceived Number 1 Preliminary number of tunneled layer 7 bytes received, excluding retransmissions Ves::ObjectClasses::GtpPerFlowMetrics::numTunneledL7BytesReceived OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY roundTripTime Number 1 Preliminary Round Trip time Ves::ObjectClasses::GtpPerFlowMetrics::roundTripTime OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY tcpFlagCountList HashMap 0..1 Preliminary Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagCountList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY tcpFlagList String 0..1 Preliminary Array of unique TCP Flags observed in the flow Ves::ObjectClasses::GtpPerFlowMetrics::tcpFlagList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeToFirstByte Number 1 Preliminary Time in milliseconds between the connection activation and first byte received Ves::ObjectClasses::GtpPerFlowMetrics::timeToFirstByte OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================================ ======== ========= ================================== =============================================================================================================================================================================================================== ======================================================================= Heartbeat ~~~~~~~~~ The heartbeatFields datatype is an optional field block for fields specific to heartbeat events. **Parent class:** VesEvent Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** additionalFields HashMap 0..1 Preliminary Additional expansion fields if needed. Ves::ObjectClasses::Heartbeat::additionalFields OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY heartbeatFieldVersion String 1 Preliminary Version of the heartbeatFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Heartbeat::heartbeatFieldVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY heartbeatInterval Integer 1 Preliminary Current heartbeatInterval in seconds. Ves::ObjectClasses::Heartbeat::heartbeatInterval OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). OpenModelAttribute the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY name String 1 Preliminary Ves::ObjectClasses::VesEvent::name OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. - isInvariant: false - valueRange: no range constraint - support: MANDATORY ======================= ========== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== HugePages ~~~~~~~~~ The hugePages datatype provides metrics on system hugePages Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =================== ======== ========= ================================== ==================================== ================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** bytesFree Number 0..1 Preliminary Number of free hugePages in bytes. Ves::ObjectClasses::HugePages::bytesFree OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY bytesUsed Number 0..1 Preliminary Number of used hugePages in bytes. Ves::ObjectClasses::HugePages::bytesUsed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY hugePagesIdentifier String 1 Preliminary HugePages identifier Ves::ObjectClasses::HugePages::hugePagesIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY percentFree Number 0..1 Preliminary Number of free hugePages in percent. Ves::ObjectClasses::HugePages::percentFree OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY percentused Number 0..1 Preliminary Number of used hugePages in percent. Ves::ObjectClasses::HugePages::percentused OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vmPageNumberFree Number 0..1 Preliminary Number of free hugePages in numbers. Ves::ObjectClasses::HugePages::vmPageNumberFree OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vmPageNumberUsed Number 0..1 Preliminary Number of used hugePages in numbers. Ves::ObjectClasses::HugePages::vmPageNumberUsed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =================== ======== ========= ================================== ==================================== ================================================== .. _ipmi-1: Ipmi ~~~~ The ipmi (Intelligent Platform Management Interface) datatype provides intelligent platform management interface metrics; it consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ====================================== ==================================== ========= ================================== =============================================== =============================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** exitAirTemperature Number 0..1 Preliminary System fan exit air flow temperature in Celsius Ves::ObjectClasses::Ipmi::exitAirTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY frontPanelTemperature Number 0..1 Preliminary Front panel temp in Celsius Ves::ObjectClasses::Ipmi::frontPanelTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ioModuleTemperature Number 0..1 Preliminary Io module temp in Celsius Ves::ObjectClasses::Ipmi::ioModuleTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY systemAirflow Number 0..1 Preliminary Airflow in cubic feet per minute (cfm) Ves::ObjectClasses::Ipmi::systemAirflow OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmibaseboardtemperature IpmiBaseboardTemperature 0..1 Preliminary Array of ipmiBaseboard Temperature objects Ves::ObjectClasses::Ipmi::_ipmibaseboardtemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmibaseboardvoltageregulator IpmiBaseboardVoltageRegulator 0..1 Preliminary Array of ipmiBaseboard VoltageRegulator objects Ves::ObjectClasses::Ipmi::_ipmibaseboardvoltageregulator OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmibattery IpmiBattery 0..1 Preliminary Array of ipmiBattery objects Ves::ObjectClasses::Ipmi::_ipmibattery OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmifan IpmiFan 0..1 Preliminary Array of ipmiFan objects Ves::ObjectClasses::Ipmi::_ipmifan OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmiglobalaggregatetemperaturemargin IpmiGlobalAggregateTemperatureMargin 0..1 Preliminary ipmi global aggregate temperature margin Ves::ObjectClasses::Ipmi::_ipmiglobalaggregatetemperaturemargin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmihsbp IpmiHsbp 0..1 Preliminary Array of ipmiHsbp objects Ves::ObjectClasses::Ipmi::_ipmihsbp OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipminic IpmiNic 0..1 Preliminary Array of ipmiNic objects Ves::ObjectClasses::Ipmi::_ipminic OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmipowersupply IpmiPowerSupply 0..1 Preliminary Array of ipmiPowerSupply objects Ves::ObjectClasses::Ipmi::_ipmipowersupply OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmiprocessor IpmiProcessor 0..1 Preliminary Array of ipmiProcessor objects Ves::ObjectClasses::Ipmi::_ipmiprocessor OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ====================================== ==================================== ========= ================================== =============================================== =============================================================== IpmiBaseboardTemperature ~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: Field Type Required? Description Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =============================== ======== ========= ================================== ========================================================== ============================================================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** baseboardTemperature Number 0..1 Preliminary Baseboard temperature in celsius Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY baseboardTemperature Identifier String 1 Preliminary Identifier for the location where the temperature is taken Ves::ObjectClasses::IpmiBaseboardTemperature::baseboardTemperature Identifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =============================== ======== ========= ================================== ========================================================== ============================================================================= IpmiBaseboardVoltageRegulator ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ==================================== ======== ========= ================================== ============================================== ======================================================================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** baseboaredVoltageRegulatorIdentifier String 1 Preliminary Identifier for the baseboard voltage regulator Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::baseboaredVoltageRegulatorIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY voltageRegulatorTemperature Number 0..1 Preliminary Voltage regulator temperature in celsius Ves::ObjectClasses::IpmiBaseboardVoltageRegulator::voltageRegulatorTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ==================================== ======== ========= ================================== ============================================== ======================================================================================= IpmiBattery ~~~~~~~~~~~ The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =================== ======== ========= ================================== ========================== ==================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** batteryIdentifier String 1 Preliminary Identifier for the battery Ves::ObjectClasses::IpmiBattery::batteryIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY batteryType String 0..1 Preliminary Type of battery Ves::ObjectClasses::IpmiBattery::batteryType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY batteryVoltageLevel Number 0..1 Preliminary Battery voltage level Ves::ObjectClasses::IpmiBattery::batteryVoltageLevel OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =================== ======== ========= ================================== ========================== ==================================================== IpmiFan ~~~~~~~ The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ========================================= ========================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** fanIdentifier String 1 Preliminary Identifier for the fan Ves::ObjectClasses::IpmiFan::fanIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY fanSpeed Number 0..1 Preliminary Fan speed in revolutions per minute (rpm) Ves::ObjectClasses::IpmiFan::fanSpeed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ========================================= ========================================== IpmiGlobalAggregateTemperatureMargin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ========================================== ======== ========= ================================== ========================================================================= ==================================================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** globalAggregateTemperatureMargin Number 0..1 Preliminary Temperature margin in Celsius relative to a throttling thermal trip point Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMargin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY globalAggregateTemperatureMarginIdentifier String 1 Preliminary Identifier for the ipmi global aggregate temperature margin metrics Ves::ObjectClasses::IpmiGlobalAggregateTemperatureMargin::globalAggregateTemperatureMarginIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ========================================== ======== ========= ================================== ========================================================================= ==================================================================================================== IpmiHsbp ~~~~~~~~ The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================================ ============================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** hsbpIdentifier String 1 Preliminary Identifier for the hot swap backplane power unit Ves::ObjectClasses::IpmiHsbp::hsbpIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY hsbpTemperature Number 0..1 Preliminary Hot swap backplane power temperature in celsius Ves::ObjectClasses::IpmiHsbp::hsbpTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================================ ============================================= IpmiNic ~~~~~~~ The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================================= =========================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** nicIdentifier String 1 Preliminary Identifier for the network interface control card Ves::ObjectClasses::IpmiNic::nicIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nicTemperature Number 0..1 Preliminary nic temperature in Celsius Ves::ObjectClasses::IpmiNic::nicTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================================= =========================================== IpmiPowerSupply ~~~~~~~~~~~~~~~ The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =============================== ======== ========= ================================== ==================================================================== ==================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** powerSupplyCurrentOutputPercent Number 0..1 Preliminary Current output voltage as a percentage of the design specified level Ves::ObjectClasses::IpmiPowerSupply::powerSupplyCurrentOutputPercent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY powerSupplyIdentifier String 1 Preliminary Identifier for the power supply Ves::ObjectClasses::IpmiPowerSupply::powerSupplyIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY powerSupplyInputPower Number 0..1 Preliminary Input power in watts Ves::ObjectClasses::IpmiPowerSupply::powerSupplyInputPower OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY powerSupplyTemperature Number 0..1 Preliminary Power supply temperature in Celsius Ves::ObjectClasses::IpmiPowerSupply::powerSupplyTemperature OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =============================== ======== ========= ================================== ==================================================================== ==================================================================== IpmiProcessor ~~~~~~~~~~~~~ The ipmiProcessor datatype provides ipmi processor metrics Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ===================================== =================================== ========= ================================== ===================================================== ======================================================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** processorThermalControlPercent Number 0..1 Preliminary Io module temperatue in celsius Ves::ObjectClasses::IpmiProcessor::processorThermalControlPercent OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY processorDtsThermalMargin Number 0..1 Preliminary Front panel temperature in celsius Ves::ObjectClasses::IpmiProcessor::processorDtsThermalMargin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_processordimmaggregatethermalmargin ProcessorDimmAggregateThermalMargin 0..1 Preliminary Array of processorDimmAggregate ThermalMargin objects Ves::ObjectClasses::IpmiProcessor::_processordimmaggregatethermalmargin OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY processorIdentifier String 1 Preliminary Identifier for the power supply Ves::ObjectClasses::IpmiProcessor::processorIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ===================================== =================================== ========= ================================== ===================================================== ======================================================================= LatencyBucketMeasure ~~~~~~~~~~~~~~~~~~~~ The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ====================== ======== ========= ================================== ======================================================== ================================================================ **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** countsInTheBucket Number 1 Preliminary Number of counts falling within a defined latency bucket Ves::ObjectClasses::LatencyBucketMeasure::countsInTheBucket OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY highEndOfLatencyBucket Number 0..1 Preliminary High end of bucket range (typically in ms) Ves::ObjectClasses::LatencyBucketMeasure::highEndOfLatencyBucket OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lowEndOfLatencyBucket Number 0..1 Preliminary Low end of bucket range (typically in ms) Ves::ObjectClasses::LatencyBucketMeasure::lowEndOfLatencyBucket OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ====================== ======== ========= ================================== ======================================================== ================================================================ Load ~~~~ The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ========================================================================================================================================================= =================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** longTerm Number 0..1 Preliminary number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg Ves::ObjectClasses::Load::longTerm OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY midTerm Number 0..1 Preliminary number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg Ves::ObjectClasses::Load::midTerm OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY shortTerm Number 0..1 Preliminary number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg Ves::ObjectClasses::Load::shortTerm OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ========================================================================================================================================================= =================================== MachineCheckException ~~~~~~~~~~~~~~~~~~~~~ The machineCheckException datatype describes machine check exceptions Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ============================= ======== ========= ================================== ============================================================================================================================================================================================================================================================== ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** correctedMemoryErrors Number 0..1 Preliminary Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY correctedMemoryErrors In1Hr Number 0..1 Preliminary Total hardware errors that were corrected by the hardware over the last one hour Ves::ObjectClasses::MachineCheckException::correctedMemoryErrors In1Hr OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vmlIdentifier String 1 Preliminary processIdentifier Ves::ObjectClasses::MachineCheckException::vmlIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY uncorrectedMemoryErrors Number 0..1 Preliminary Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY uncorrectedMemoryErrors In1Hr Number 0..1 Preliminary Total uncorrected hardware errors that were detected by the hardware over the last one hour Ves::ObjectClasses::MachineCheckException::uncorrectedMemoryErrors In1Hr OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ============================= ======== ========= ================================== ============================================================================================================================================================================================================================================================== ======================================================================== MeasDataCollection ~~~~~~~~~~~~~~~~~~ The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ============================= ======== ========= ================================== ================================================================================ ===================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** formatVersion String 0..1 Preliminary 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 Ves::ObjectClasses::MeasDataCollection::formatVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY granularityPeriod String 1 Preliminary Granularity period for the PM report in seconds Ves::ObjectClasses::MeasDataCollection::granularityPeriod OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measObjInstIdList String 0..1 Preliminary Array of monitored object local distinguished name ids per 3GPP TS 32.300 Ves::ObjectClasses::MeasDataCollection::measObjInstIdList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measuredEntityDn String 1 Preliminary Distinguished name per 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntityDn OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measuredEntitySoftwareVersion String 0..1 Preliminary Software version for the NF providing the PM data as specified in 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntitySoftwareVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measuredEntityUserName String 0..1 Preliminary User Definable name for the measured object per 3GPP TS 28.550 Ves::ObjectClasses::MeasDataCollection::measuredEntityUserName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measinfo MeasInfo 1..\* Preliminary Array of monitored object local distinguished name ids per 3GPP TS 32.300 Ves::ObjectClasses::MeasDataCollection::_measinfo OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ============================= ======== ========= ================================== ================================================================================ ===================================================================== MeasInfo ~~~~~~~~ Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =================== ================= ========= ================================== ================================================================================================================================= ================================================ **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** jobId String 0..1 Preliminary Name of the measurement job Ves::ObjectClasses::MeasInfo::jobId OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measinfoidinteger measInfoIdInteger 0..1 Preliminary Measurement group Identifier Ves::ObjectClasses::MeasInfo::_measinfoidinteger OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measinfoidstring MeasInfoIdString 0..1 Preliminary Measurement group Identifier Ves::ObjectClasses::MeasInfo::_measinfoidstring OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_meastypesinteger MeasTypesInteger 0..1 Preliminary Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings Ves::ObjectClasses::MeasInfo::_meastypesinteger OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_meastypesstring MeasTypesString 0..1 Preliminary Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings Ves::ObjectClasses::MeasInfo::_meastypesstring OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measValuesList MeasValues 1..\* Experimental Array of measValues Ves::ObjectClasses::MeasInfo::_measValuesList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =================== ================= ========= ================================== ================================================================================================================================= ================================================ MeasInfoIdString ~~~~~~~~~~~~~~~~ The measInfoIdString datatype provides a string measurement group identifier; Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== =================================== ================================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** sMeasInfoId Integer 1 Preliminary String measurement group Identifier Ves::ObjectClasses::MeasInfoIdString::sMeasInfoId OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== =================================== ================================================= MeasResultInteger ~~~~~~~~~~~~~~~~~ The measResultInteger datatype provides an integer 3GPP PM measurement result; Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================ ============================================= **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MeasResultInteger::p OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY iValue Integer 1 Preliminary Integer counter value Ves::ObjectClasses::MeasResultInteger::iValue OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================ ============================================= MeasResultString ~~~~~~~~~~~~~~~~ The measResultString datatype provides a string 3GPP PM measurement result; Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================ ============================================ **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MeasResultString::p OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY sVlaue String 1 Preliminary String counter value Ves::ObjectClasses::MeasResultString::sVlaue OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================ ============================================ MeasTypesInteger ~~~~~~~~~~~~~~~~ The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================================================================ ==================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** iMeasTypesList Integer 1..\* Preliminary Array of integer measurement identifiers associated with the measurement results Ves::ObjectClasses::MeasTypesInteger::iMeasTypesList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================================================================ ==================================================== MeasTypesString ~~~~~~~~~~~~~~~ The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== =============================================================================== =================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** sMeasTypesList String 1..\* Preliminary Array of string measurement identifiers associated with the measurement results Ves::ObjectClasses::MeasTypesString::sMeasTypesList OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== =============================================================================== =================================================== MeasValues ~~~~~~~~~~ The measValues datatype provides 3GPP measurement values Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary =================== ================= ========= ================================== ================================================================= ================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** measObjAddFlds HashMap 0..1 Preliminary Additional key-value pairs if needed Ves::ObjectClasses::MeasValues::measObjAddFlds OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY suspectFlag Boolean 1 Preliminary Enumeration: 'true', 'false'. Indicates if the values are suspect Ves::ObjectClasses::MeasValues::suspectFlag OpenModelAttribute VES 7.1 Spec has this attribute as a string. - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measresultinteger MeasResultInteger 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultinteger OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measresultnull measResultNull 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultnull OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_mesresultnumber MesResultNumber 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_mesresultnumber OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_measresultstring MeasResultString 0..\* Preliminary Array of results Ves::ObjectClasses::MeasValues::_measresultstring OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY =================== ================= ========= ================================== ================================================================= ================================================== Measurement ~~~~~~~~~~~ Fields specific to measurement events **Parent class:** VesEvent Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ======================== ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** additionalFields HashMap 0..1 Preliminary Additional measurement fields if needed. Ves::ObjectClasses::Measurement::additionalFields OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY additionalMeasurements ArrayofNamedHashMap 0..1 Preliminary Array of named hashMap if needed. Ves::ObjectClasses::Measurement::additionalMeasurements OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY additionalObjects ArrayOfSchemaObject 0..1 Preliminary Array of Schema objects described by name, schema and other meta-information, if needed. Ves::ObjectClasses::Measurement::additionalObjects OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY concurrentSessions Integer 0..1 Preliminary Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval. Ves::ObjectClasses::Measurement::concurrentSessions OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY configuredEntities Integer 0..1 Preliminary Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF Ves::ObjectClasses::Measurement::configuredEntities OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY featureUsageArray HashMap 0..1 Preliminary The hashMap key should identify the feature, while the value defines the number of times the identified feature was used. Ves::ObjectClasses::Measurement::featureUsageArray OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY meanRequestLatency Number 0..1 Preliminary Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running. Ves::ObjectClasses::Measurement::meanRequestLatency OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measurementFieldsVersion String 1 Preliminary Version of the measurementFields block as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::Measurement::measurementFieldsVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY measurementInterval Number 1 Preliminary Interval over which measurements are being reported in seconds Ves::ObjectClasses::Measurement::measurementInterval OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcScalingMetric Integer 0..1 Preliminary Represents busy-ness of the network function from 0 to 100 as reported by the nfc. Ves::ObjectClasses::Measurement::nfcScalingMetric OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY numberOfMediaPortsInUse Integer 1 Preliminary Number of media ports in use. Ves::ObjectClasses::Measurement::numberOfMediaPortsInUse OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY requestRate Number 1 Preliminary Peak request rate per second, for the VM over the measurementInterval Ves::ObjectClasses::Measurement::requestRate OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_Hugepages HugePages 0..1 Preliminary Array of metrics on hugePages Ves::ObjectClasses::Measurement::_Hugepages OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_codecsinuse CodecsInUse 0..\* Preliminary Array of codecs in use Ves::ObjectClasses::Measurement::_codecsinuse OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_cpuUsage CpuUsage 0..\* Preliminary Usage of an array of CPUs Ves::ObjectClasses::Measurement::_cpuUsage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_diskUsage DiskUsage 0..\* Preliminary Usage of an array of disks Ves::ObjectClasses::Measurement::_diskUsage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_filesystemusage FilesystemUsage 0..\* Preliminary Filesystem usage of the VM on which the xNFC reporting the event is running Ves::ObjectClasses::Measurement::_filesystemusage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_ipmi Ipmi 0..1 Preliminary Array of intelligent platform management interface metrics Ves::ObjectClasses::Measurement::_ipmi OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_latencybucketmeasure LatencyBucketMeasure 0..1 Preliminary Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. Ves::ObjectClasses::Measurement::_latencybucketmeasure OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_load Load 0..1 Preliminary Array of system load metrics Ves::ObjectClasses::Measurement::_load OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_machinecheckexception MachineCheckException 0..1 Preliminary Array of machine check exceptions Ves::ObjectClasses::Measurement::_machinecheckexception OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_memoryusage MemoryUsage 0..\* Preliminary Memory usage of an array of VMs Ves::ObjectClasses::Measurement::_memoryusage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_nicperformance NicPerformance 0..\* Preliminary Performance metrics of an array of network interface cards Ves::ObjectClasses::Measurement::_nicperformance OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_processstats ProcessStats 0..\* Preliminary Array of metrics on system processes Ves::ObjectClasses::Measurement::_processstats OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). OpenModelAttribute the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY name String 1 Preliminary Ves::ObjectClasses::VesEvent::name OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. - isInvariant: false - valueRange: no range constraint - support: MANDATORY ======================== ===================== ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== MemoryUsage ~~~~~~~~~~~ The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ==================== ======== ========= ================================== =============================================================================================================================== ===================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** memoryBuffered Number 0..1 Preliminary Kibibytes of temporary storage for raw disk blocks Ves::ObjectClasses::MemoryUsage::memoryBuffered OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryCached Number 0..1 Preliminary Kibibytes of memory used for cache Ves::ObjectClasses::MemoryUsage::memoryCached OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryConfigured Number 0..1 Preliminary Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running Ves::ObjectClasses::MemoryUsage::memoryConfigured OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryDemand Number 0..1 Preliminary Host demand in kibibytes Ves::ObjectClasses::MemoryUsage::memoryDemand OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryFree Number 1 Preliminary Kibibytes of physical RAM left unused by the system Ves::ObjectClasses::MemoryUsage::memoryFree OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryLatencyAvg Number 0..1 Preliminary Percentage of time the VM is waiting to access swapped or compressed memory Ves::ObjectClasses::MemoryUsage::memoryLatencyAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySharedAvg Number 0..1 Preliminary Shared memory in kilobytes Ves::ObjectClasses::MemoryUsage::memorySharedAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySlabRecl Number 0..1 Preliminary The part of the slab that can be reclaimed such as caches measured in kibibytes Ves::ObjectClasses::MemoryUsage::memorySlabRecl OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySlabUnrecl Number 0..1 Preliminary The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes Ves::ObjectClasses::MemoryUsage::memorySlabUnrecl OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySwapInAvg Number 0..1 Preliminary Amount of memory swapped-in from host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapInAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySwapInRateAvg Number 0..1 Preliminary Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second Ves::ObjectClasses::MemoryUsage::memorySwapInRateAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySwapOutAvg Number 0..1 Preliminary Amount of memory swapped-out to host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapOutAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySwapOutRateAvg Number 0..1 Preliminary Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second Ves::ObjectClasses::MemoryUsage::memorySwapOutRateAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memorySwapUsedAvg Number 0..1 Preliminary Space used for caching swapped pages in the host cache in kibibytes Ves::ObjectClasses::MemoryUsage::memorySwapUsedAvg OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY memoryUsed Number 1 Preliminary Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes Ves::ObjectClasses::MemoryUsage::memoryUsed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY percentMemoryUsage Number 0..1 Preliminary Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. Ves::ObjectClasses::MemoryUsage::percentMemoryUsage OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vmIdentifier String 1 Preliminary Virtual Machine identifier associated with the memory metrics Ves::ObjectClasses::MemoryUsage::vmIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ==================== ======== ========= ================================== =============================================================================================================================== ===================================================== MesResultNumber ~~~~~~~~~~~~~~~ The measResultNumber datatype provides a number 3GPP PM measurement result Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ================== ======== ========= ================================== ================================ =========================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** p Integer 1 Preliminary Integer reference to the counter Ves::ObjectClasses::MesResultNumber::p OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY rValue Number 1 Preliminary Number counter value Ves::ObjectClasses::MesResultNumber::rValue OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ================== ======== ========= ================================== ================================ =========================================== MobileFlow ~~~~~~~~~~ Fields specific to mobility flow events **Parent class:** VesEvent Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ======================= ================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** additionalFields HashMap 0..1 Preliminary additionalFields - Additional mobileFlow fields if needed. Ves::ObjectClasses::MobileFlow::additionalFields OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY applicationType String 0..1 Preliminary applicationType - Application type inferred Ves::ObjectClasses::MobileFlow::applicationType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY applProtocolType String 0..1 Preliminary applProtocolType - Application protocol. Ves::ObjectClasses::MobileFlow::applProtocolType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY applProtocolVersion String 0..1 Preliminary applProtocolVersion - Application version. Ves::ObjectClasses::MobileFlow::applProtocolVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY cid String 0..1 Preliminary cid - Cell Id. Ves::ObjectClasses::MobileFlow::cid OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY connectionType String 0..1 Preliminary connectionType - Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc. Ves::ObjectClasses::MobileFlow::connectionType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ecgi String 0..1 Preliminary ecgi - Evolved Cell Global Id. Ves::ObjectClasses::MobileFlow::ecgi OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY flowDirection String 0..1 Preliminary flowDirection - Flow direction, indicating if the reporting node is the source of the flow or destination for the flow. Ves::ObjectClasses::MobileFlow::flowDirection OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY gtpProtocolType String 0..1 Preliminary gtpProtocolType - GTP protocol Ves::ObjectClasses::MobileFlow::gtpProtocolType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY gtpVersion String 0..1 Preliminary gtpVersion - GTP protocol version. Ves::ObjectClasses::MobileFlow::gtpVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY httpHeader String 0..1 Preliminary httpHeader - HTTP request header, if the flow connects to a node referenced by HTTP. Ves::ObjectClasses::MobileFlow::httpHeader OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY iemi String 0..1 Preliminary imei - IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device. Ves::ObjectClasses::MobileFlow::iemi OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY imsi String 0..1 Preliminary imsi - IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device Ves::ObjectClasses::MobileFlow::imsi OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ipProtocolType String 0..1 Preliminary ipProtocolType - IP protocol type e.g., TCP, UDP, RTP... Ves::ObjectClasses::MobileFlow::ipProtocolType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ipVersion String 0..1 Preliminary ipVersion - IP protocol version e.g., IPv4, IPv6 Ves::ObjectClasses::MobileFlow::ipVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lac String 0..1 Preliminary lac - Location area code. Ves::ObjectClasses::MobileFlow::lac OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mcc String 0..1 Preliminary mcc - Mobile country code. Ves::ObjectClasses::MobileFlow::mcc OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mnc String 0..1 Preliminary mnc - Mobile network code. Ves::ObjectClasses::MobileFlow::mnc OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY mobileFlowFieldsVersion Number 0..1 Preliminary mobileFlowFieldsVersion - Version of the mobileFlowFields block. Ves::ObjectClasses::MobileFlow::mobileFlowFieldsVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY msisdn String 0..1 Preliminary msisdn - MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device. Ves::ObjectClasses::MobileFlow::msisdn OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY otherEndpointlpAddress String 0..1 Preliminary otherEndpointIpAddress - IP address for the other endpoint, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::otherEndpointlpAddress Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY otherEndpointPort Number 0..1 Preliminary otherEndpointPort - IP Port for the reporting entity, as used for the flow being reported on Ves::ObjectClasses::MobileFlow::otherEndpointPort OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY otherFunctionalRole String 0..1 Preliminary otherFunctionalRole - Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... Ves::ObjectClasses::MobileFlow::otherFunctionalRole OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY rac String 0..1 Preliminary rac - Routing area code Ves::ObjectClasses::MobileFlow::rac OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY radioAccessTechnology String 0..1 Preliminary radioAccessTechnology - Radio Access Technology e.g., 2G, 3G, 4G and 5G. (GSM, UMTS, LTE, 5G) Ves::ObjectClasses::MobileFlow::radioAccessTechnology OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEndpointlpAddr String 0..1 Preliminary reportingEndpointIpAddr - IP address for the reporting entity, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::reportingEndpointlpAddr Note: current data type (String) may be changed to Common Resource Datatype L3AddressData. =[gh]= OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEndpointPort Number 0..1 Preliminary reportingEndpointPort - IP port for the reporting entity, as used for the flow being reported on. Ves::ObjectClasses::MobileFlow::reportingEndpointPort OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY sac String 0..1 Preliminary sac - Service area code Ves::ObjectClasses::MobileFlow::sac OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY samplingAlgorithm Number 0..1 Preliminary samplingAlgorithm - Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied. Ves::ObjectClasses::MobileFlow::samplingAlgorithm OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY tac String 0..1 Preliminary tac - Transport area code Ves::ObjectClasses::MobileFlow::tac OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY tunnelId String 0..1 Preliminary tunnelId - Tunnel identifier Ves::ObjectClasses::MobileFlow::tunnelId OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vlanId String 0..1 Preliminary vlanId - VLAN identifier used by this flow Ves::ObjectClasses::MobileFlow::vlanId OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY \_gtpperflowmetrics GtpPerFlowMetrics 1 Preliminary Mobility GTP Protocol per flow metrics Ves::ObjectClasses::MobileFlow::_gtpperflowmetrics OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY domain Domain 1 Experimental Update in definition only Ves::ObjectClasses::VesEvent::domain OpenModelAttribute Event domain enumeration: 'cmNotify','fault', 'heartbeat', 'measurement', 'mobileFlow', 'notification', 'other', 'pnfRegistration', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' - isInvariant: false - valueRange: no range constraint - support: MANDATORY eventType String 0..1 Preliminary For example: 'applicationNf', 'guestOS', 'hostOS', 'platform' Ves::ObjectClasses::VesEvent::eventType OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY lastEpochMicrosec Number 1 Preliminary the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds Ves::ObjectClasses::VesEvent::lastEpochMicrosec OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfcNamingCode String 0..1 Preliminary Network function component type: 3 characters (aligned with vfc naming standards) Ves::ObjectClasses::VesEvent::nfcNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfNamingCode String 0..1 Preliminary Network function type: 4 characters (aligned with vnf and pnf naming standards) Ves::ObjectClasses::VesEvent::nfNamingCode OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nfVendorName String 1 Preliminary Network function vendor name Ves::ObjectClasses::VesEvent::nfVendorName OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY priority Priority 1 Preliminary Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' Ves::ObjectClasses::VesEvent::priority OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityId String 0..1 Preliminary UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See 'reportingEntityName' for more information. Ves::ObjectClasses::VesEvent::reportingEntityId OpenModelAttribute reportingEntityId - UUID identifying the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. Note: the AT&T internal enrichment process shall ensure that this field is populated. The reportingEntityId is an id for the reportingEntityName. See reportingEntityName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY reportingEntityName String 1 Preliminary reportingEntityName - Name of the entity reporting the event or detecting a problem in another xnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. Ves::ObjectClasses::VesEvent::reportingEntityName OpenModelAttribute Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sequence Integer 1 Preliminary sequence - Ordering of events communicated by an event source instance (or 0 if not needed) Ves::ObjectClasses::VesEvent::sequence OpenModelAttribute Ordering of events communicated by an event source instance (or 0 if not needed) - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceId String 0..1 Preliminary UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See 'sourceName' for more information. Ves::ObjectClasses::VesEvent::sourceId OpenModelAttribute sourceId - UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity Note: the AT&T internal enrichment process shall ensure that this field is populate). The sourceId is an id for the sourceName. See sourceName for more information. - isInvariant: false - valueRange: no range constraint - support: MANDATORY sourceName String 1 Preliminary Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. Ves::ObjectClasses::VesEvent::sourceName OpenModelAttribute sourceName - Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNFC or VM, then the event must be reporting data for that particular xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. - isInvariant: false - valueRange: no range constraint - support: MANDATORY startingEpochMicrosec Number 1 Preliminary startEpochMicrosec - the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). Ves::ObjectClasses::VesEvent::startingEpochMicrosec For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpochMicrosec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and DCAE collector will replace it with Collector time stamp (when event is received). OpenModelAttribute the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) - isInvariant: false - valueRange: no range constraint - support: MANDATORY timeZoneOffset String 0..1 Preliminary Offset to GMT to indicate local time zone for device formatted as 'UTC+/-hh:mm'; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples Ves::ObjectClasses::VesEvent::timeZoneOffset OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY version String 1 Preliminary Version of the event header as "#.#" where # is a digit; see section 1 for the correct digits to use. Ves::ObjectClasses::VesEvent::version OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY vesEventListenerVersion String 1 Preliminary Version of the ves event listener api spec that this event is compliant with (as "#" or "#.#" or "#.#.#" where # is a digit; see section 1 for the correct digits to use). Ves::ObjectClasses::VesEvent::vesEventListenerVersion OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY name String 1 Preliminary Ves::ObjectClasses::VesEvent::name OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth Common::Business Interaction::ObjectClasses::BusinessInteraction::Status OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. - isInvariant: false - valueRange: no range constraint - support: MANDATORY ======================= ================= ========= ================================== ============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ ======================================================================== NicPerformance ~~~~~~~~~~~~~~ The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card Applied stereotypes: - OpenModelClass - **support: MANDATORY** - Preliminary ====================================== ============= ========= ================================== ================================================================================================================================================================================== ========================================================================== **Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in** administrativeState NicAdminState 0..1 Preliminary Administrative state: enum: 'inService', 'outOfService' Ves::ObjectClasses::NicPerformance::administrativeState OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY nicIdentifier String 1 Preliminary Network interface card identifier Ves::ObjectClasses::NicPerformance::nicIdentifier OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY operationalState NicOpsState 0..1 Preliminary Operational state: enum: 'inService', 'outOfService' Ves::ObjectClasses::NicPerformance::operationalState OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedBroadcastPacketsAccumulated Number 0..1 Preliminary Cumulative count of broadcast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedBroadcastPacketsDelta Number 0..1 Preliminary Count of broadcast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedBroadcastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedDiscardedPacketsAccumulated Number 0..1 Preliminary Cumulative count of discarded packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedDiscardedPacketsDelta Number 0..1 Preliminary Count of discarded packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedDiscardedPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedErrorPacketsAccumulated Number 0..1 Preliminary Cumulative count of error packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedErrorPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedErrorPacketsDelta Number 0..1 Preliminary Count of error packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedErrorPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedMulticastPacketsAccumulated Number 0..1 Preliminary Cumulative count of multicast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedMulticastPacketsDelta Number 0..1 Preliminary Count of multicast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedMulticastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedOctetsAccumulated Number 0..1 Preliminary Cumulative count of octets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedOctetsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedOctetsDelta Number 0..1 Preliminary Count of octets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedOctetsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedPercentDiscard Number 0..1 Preliminary Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedPercentDiscard OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedPercentError Number 0..1 Preliminary Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedPercentError OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedTotalPacketsAccumulated Number 0..1 Preliminary Cumulative count of all packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedTotalPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedTotalPacketsDelta Number 0..1 Preliminary Count of all packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedTotalPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedUnicastPacketsAccumulated Number 0..1 Preliminary Cumulative count of unicast packets received as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedUnicastPacketsDelta Number 0..1 Preliminary Count of unicast packets received within the measurement interval Ves::ObjectClasses::NicPerformance::receivedUnicastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY receivedUtilization Number 0..1 Preliminary Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::receivedUtilization OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY speed Number 0..1 Preliminary Speed configured in mbps. Ves::ObjectClasses::NicPerformance::speed OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedBroadcastPacketsAccumulated Number 0..1 Preliminary Cumulative count of broadcast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedBroadcastPacketsDelta Number 0..1 Preliminary Count of broadcast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedBroadcastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedDiscardedPacketsAccumulated Number 0..1 Preliminary Cumulative count of discarded packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedDiscardedPacketsDelta Number 0..1 Preliminary Count of discarded packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedDiscardedPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedErrorPacketsAccumulated Number 0..1 Preliminary Cumulative count of error packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedErrorPacketsDelta Number 0..1 Preliminary Count of error packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedErrorPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedMulticastPacketsAccumulated Number 0..1 Preliminary Cumulative count of multicast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedMulticastPacketsDelta Number 0..1 Preliminary Count of multicast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedMulticastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedOctetsAccumulated Number 0..1 Preliminary Cumulative count of octets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedOctetsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedOctetsDelta Number 0..1 Preliminary Count of octets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedOctetsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedPercentDiscard Number 0..1 Preliminary Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedPercentDiscard OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedPercentError Number 0..1 Preliminary Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedPercentError OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedTotalPacketsAccumulated Number 0..1 Preliminary Cumulative count of all packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedTotalPacketsDelta Number 0..1 Preliminary Count of all packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedTotalPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedUnicastPacketsAccumulated Number 0..1 Preliminary Cumulative count of unicast packets transmitted as read at the end of the measurement interval Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsAccumulated OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedUnicastPacketsDelta Number 0..1 Preliminary Count of unicast packets transmitted within the measurement interval Ves::ObjectClasses::NicPerformance::transmittedUnicastPacketsDelta OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY transmittedUtilization Number 0..1 Preliminary Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. Ves::ObjectClasses::NicPerformance::transmittedUtilization OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY valuesAreSuspect Boolean 1 Preliminary Enumeration: 'true' or 'false'. If 'true' then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. Ves::ObjectClasses::NicPerformance::valuesAreSuspect OpenModelAttribute - isInvariant: false - valueRange: no range constraint - support: MANDATORY ====================================== ============= ========= ================================== ================================================================================================================================================================================== ==========================================================================